One moment please...
Untitled Document

Exact Globe

How-to: Editing ESL File to Accommodate Customized Fields on Layouts

Introduction

By default, customized fields created with Exact Extender cannot be added to the layouts in Exact Globe. In order to do this, you need to edit the Exact Standard Layout (ESL) files in the installation directory of Exact Globe. This document explains the steps for editing the ESL file to accommodate customized fields on the layouts. The following steps are involved:

  1. Opening an ESL file
  2. Selecting a block for customized field
  3. Adding a field to a layout block
  4. Saving the ESL file
  5. Adding fields to the layout

It is advisable to backup a copy of the ESL file before any modification is made. This is to ensure that you can restore the original ESL file if anything goes wrong during the process.

Description

Opening an ESL file

An ESL file is divided into two sections: group definition section and field definition section. “Blocks” are usually defined in the group definition section. For example the Header block and Address block. In the field definition section, the selectable fields per block are defined. This is similar to adding database fields to maintenance layouts.

  1. Go to the ETC directory of Exact Globe installation folder and locate the relevant ESL file. In this example, the Exact Globe installation folder is stored in C:\Program Files\Exact Software\etc.
  2. Double-click on the relevant ESL file (for example, Faktuur.esl) to open it.      

Top

Selecting a block for customized field

At the group definition section of the ESL file, identify the most suitable “block” for your customized field. For example, a customized field with additional debtors’ or creditors’ address-related data can be assigned to the Address block and a customized field with additional item-related data can be assigned to the Item block.

Top

Adding a field to a layout block

  1. At the field definition section of the ESL file, locate the identified “block” based on its numeric identifier.
  2. Add a new field definition at the “block”. Every field definition consists of 11 field characteristics separated by a comma to define the customized field. For example, “1, Our ref., LSV_NOFLAG, NOFUNC, @sp(FAKTNR), NOFUNC, LT_LONG, 8, 0, 0,119”. The following explains each of the field’s characteristics:

1

Field ID: The maximum available number is 299. It is recommended to add new customized fields to the end of the block. You can define the field with the maximum available number (299) and start the number in descending order whenever you add a new customized field. If all 299 fields are occupied in a particular block, you can replace some currently unused fields with the customized fields.

2

Description field: Enter the description of the field that is shown at layout. 

3

Field flag: Enter “LSV_NOTEMPTY” so that no value is displayed if it is a “0”.  Otherwise, enter “LSV_NOFLAG”. 

4

Flag function: Enter “NOFUNC”.

5

Path to field: Specify the path to locate the fields when adding database fields. In order to specify the path, you may require some knowledge of the available tables which the fields are linked to. The following tables may be useful to you:

Table

Description

frsrg

Invoice sub-lines

frkrg

Invoice header

orsrg

Order sub-lines

orkrg

Order header

SDKfrs

SDK table invoice sub-lines

SDKfrk

SDK table invoice header

SDKsrg

SDK table order sub-lines

SDKkrg

SDK table order header

The path definition should be:

<Base table>^^<Linked table>^<Unique link>^<Customized field>

  • Base table: for example, frsrg
  • Linked table: for example, SDKfrs
  • Unique link: for example, sysguid
  • Customized field: for example, Licenseplate

    Example 1:

    When adding a customized field to the invoice/order sub-lines layout, you need to define a link between the base table and the linked table. In this example, a customized field “Licenseplate” is added to the invoice/order sub-lines by using Exact Extender. Then you create a link between the base table and the linked table for invoice/order sub-lines by using a unique link key (“sysguid”). As a result, the paths to field will be:

             frsrg^^SDKfrs^sysguid^licenseplate

             orsrg^^SDKsrg^sysguid^licenseplate

    Example 2:

    When adding a customized field called “PurchaseAgent” to the invoice/order layout, you are required to create two links. The first link is from the invoice/order header tables (frkrg/orkrg) to the invoice/order sub-lines tables (frsrg/orsrg) and the second link is from the invoice/order sub-lines tables (frsrg/orsrg) to their respective SDK tables. This is done by using two unique link keys. For example, “volgnr5”/”ordernr” and “sysguid”. As a result, the paths to field will be:   

             frsrg^^frkrg^volgnr5^ SDKfrk ^sysguid^PurchaseAgent

             orsrg^^orkrg^ordernr^ SDKkrg ^sysguid^PurchaseAgent

    Example 3:

    The third example is to display the full name of an employee in a customized field at a layout. For example, a customized field, namely “Driver” is added to the invoice/order sub-lines layout. This customized field is linked to the Human resources (humres) reference table. By default, the resource ID of the employee will be shown at this customized field. If you want to display the employee’s full name instead of the resource ID on the invoice/order sub-lines layout, you must create a link to the SDK table besides creating a link to the Human resources (humres) table:

             frsrg^^SDKfrs^sysguid^humres^Driver^fullname      

             orsrg^^SDKsrg^sysguid^humres^Driver^fullname

    For more information, see SDK – How to get custom fields on a layout.

    Note: The field name of the customized field cannot be longer than 11 characters and are case-sensitive.

  • 6

    Field function: Enter “NOFUNC”.

    7

    Field type: Enter the appropriate field types. 

    Type

    When to use

    LT_LAS

    Data type is String

    LT_LONG

    Data type is Long

    LT_DBL

    Data type is Double

    LT_NOYES

    Data type is No/Yes

    LT_DAT

    Data type is Date

    8

    Length: Enter the length of the field. For example, the number of characters allowed for the field.

    9

    Precision: Enter the precision of the field. Enter “0” if it is not applicable.

    10

    Option expression: Enter “0” for the option expression of the field.

    11

    Term ID:  Enter the term ID of the field. 

    Top

    Saving the ESL file

    Click Save at the File menu to save the edited ESL file with the same file name at the ETC directory.  

    Top

    Adding fields to the layout

    After the customized fields are added to the ESL file, you can select them when customizing a layout. If a customized field is added to the layouts, it is shown in all the relevant documents such as invoices, receipts and delivery notes. For more information, see SDK: How to get custom fields on a layout.

    Note: Fields can only be added from the standard tables such as financial entries, financial entry lines, accounts, invoices, invoice lines, items, orders, order lines, project, resource, contacts, general ledger, quotation, and bills of materials. You can only add fields from the corresponding tables to the corresponding layouts. For example, adding fields from the invoice table to the invoice layout.

    Top

    Related document

     

    Document Number: 18.610.384

    Disclaimer
    Despite the continued efforts of Exact to ensure that the information in this document is as complete and up-to-date as possible, Exact can not be held accountable for the correctness and/or completeness and/or specific applicability of the published and/or requested information in this document. Exact shall not be liable for any direct, indirect, incidental, special or consequential damages, lost profits or for business interruption arising out of the use of this document. The extraction and use of information from this document remains at all times completely within the user's own risk.